Skip to content

Swap GitHub and Terrform logos depending on light or dark mode#3264

Open
thekbb wants to merge 9 commits intointegrations:mainfrom
thekbb:swap-logos-for-dark-mode
Open

Swap GitHub and Terrform logos depending on light or dark mode#3264
thekbb wants to merge 9 commits intointegrations:mainfrom
thekbb:swap-logos-for-dark-mode

Conversation

@thekbb
Copy link
Copy Markdown
Contributor

@thekbb thekbb commented Mar 10, 2026

Resolves #3263


Before the change?

When using GitHub's dark theme, the GitHub and Terraform logos are difficult to read:
existing readme with dark theme

After the change?

The Readme uses the picture element, which is supported in GitHub markdown, to swap out the assets depending on current theme.
The default is light mode.

Light theme:
screenshot in light mode

Dark theme:
screenshot in dark mode

I added the svg assets to readme-assets/, as well as slightly decreasing the size (height 50px, rather than 70px), and centered rather then left justified.

The markdownlint.yaml file has a rule against in-line-html enabled. I've disabled it for the section I've added.

Pull request checklist

  • Schema migrations have been created if needed (example)
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

@github-actions
Copy link
Copy Markdown

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

deiga
deiga previously approved these changes Mar 22, 2026
Copy link
Copy Markdown
Collaborator

@deiga deiga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks clean to me

@austenstone
Copy link
Copy Markdown
Contributor

Can we avoid committing the assets to source? We don't need another root folder

No need to center them and take up vertical space. Let's just replace with proper logos.

@thekbb
Copy link
Copy Markdown
Contributor Author

thekbb commented Apr 22, 2026

Can we avoid committing the assets to source? We don't need another root folder

No need to center them and take up vertical space. Let's just replace with proper logos.

Thanks, @austenstone! I can definitely clean up the spacing layout to match the original.

I was hoping to avoid committing the assets, but I ran into the same issue you did in #3278: when I upload them in a comment, the resulting user-attachments URL ends up 404ing.

I'm all for advice, thoughts?

@thekbb
Copy link
Copy Markdown
Contributor Author

thekbb commented Apr 22, 2026

here are the images, if you look at the URL it includes a jwt=... query param with an exp claim. A short-lived signed URL rather, than a durable public asset URL. That would explain the 404s.

If we can't find a solution for durable URL, would moving /readme-assets/ to /.github/readme-assets be workable?

github-octocat-dark.svg:
github-octocat-dark


github-octocat-light.svg:
github-octocat-light


hashicorp-terraform-dark.svg:
hashicorp-terraform-dark


hashicorp-terraform-light.svg:
hashicorp-terraform-light

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG]: Logo images in README are not suited for dark theme

3 participants